home *** CD-ROM | disk | FTP | other *** search
/ AOL File Library: 9,300 to 9,399 / 9300.zip / AOLDLs / Helper Apps (MAC) / HELPER_ SaintEdit 1.5b13 / SaintEdit 1.5b13.sit / SaintEdit 1.5b13 / SaintEdit Documentation < prev   
Text File  |  1996-03-09  |  16KB  |  296 lines

  1. SaintEdit 1.5 Documentation
  2.  
  3. Released Thursday, July 28, 1994
  4.  
  5. ______________________________________________________________________________
  6.  
  7. DESCRIPTION
  8.  
  9. SaintEdit is a robust, general purpose text editor; not a word processor, not a page layout program, not a draw program. Designed to read and edit enormous text files and to transparently handle multiple platform translations. Though it was intended to be a simple, trivial piece of software when I started on it a few years back, it soon became a very significant, major application.
  10.     
  11. SaintEdit has an intuitive, aesthetically pleasing user interface. It is extremely fast and does not bog down when the file sizes get large. Though it is commercial grade software, I have elected to distribute it as a shareware product, ridiculously priced at a paltry $10.00. I'll support you if you support me...
  12.  
  13. ______________________________________________________________________________
  14.  
  15. SYSTEM REQUIREMENTS
  16.  
  17. ANY Macintosh capable of running System 7, though SaintEdit really shines if you've got a color monitor and gobs of RAM.
  18.  
  19. ______________________________________________________________________________
  20.  
  21. APPLE MENU
  22.  
  23.     About SaintEdit
  24. This is the usual About Box stuff; back-patting, name calling, etc.
  25.  
  26.     Register SaintEdit
  27. You will be asked to fill out a form and print it. If you do not have access to a printer, send your name, address and online account info (if available) to the address at the end of this document.
  28. ______________________________________________________________________________
  29.  
  30. FILE MENU
  31.  
  32.     New
  33. Opens a new document. You may only have ten (10) documents open at a time. You may also use Command-N from the keyboard.
  34.  
  35.     Open
  36. Opens an existing document. Any file with the type 'TEXT' can be opened. You are presented with the standard Mac 'what file do you want to open' interface. If you can't figure this part out, how did you get this far?
  37.  
  38.     Close
  39. Closes the current document's window (the active window is the front most window with close and zoom boxes visible in the title bar). If you have created a new document or edited an existing document, you will be asked if you wish to save your work. You may also use Command-W from the keyboard. You may also click the close box in the title bar. Holding Option and clicking the close box will close all document windows. 
  40.  
  41.     Revert File
  42. Opens the last saved copy of the current document, throwing away all changes made since it was saved.  This is a quick way to 'start over' your editing process, say if you did a 'Replace All' and screwed up... You will be asked to confirm this action as it is not undoable.
  43.  
  44.     Save
  45. Saves the current document. If you had created a new document, you will be asked what to name the document and on which disk device you would like to save it.  If you were editing an existing document, it will be save with it's original name and location and format without notification.
  46.  
  47.     Save as
  48. This option allows you to save your document in one of five TEXT formats; Macintosh TEXT, DOS TEXT, Unix TEXT, TeachText TEXT or TeachText Read Only.  Select the desired format from the pull-down menu, name your document, choose a location to save it and click the Save button, or press the Return key.
  49.  
  50.     Page Setup
  51. This will take you to the page set-up for the selected printer.  Make sure you have chosen a printer using the Chooser under the Apple Menu first!
  52.  
  53.     Print
  54. This will take you to the print dialog for the selected printer.  This will vary depending on the printer type.
  55.  
  56.     Quit
  57. This will quit SaintEdit.  All windows will be closed, and those that have not been saved will ask if you wish to save of discard your work.
  58.  
  59. ______________________________________________________________________________
  60.  
  61. EDIT MENU
  62.  
  63.     Undo/Redo Typing
  64. Will undo the LAST edit action you did; typing, deleting, etc.  Once you have un-done it, you may redo it by choosing this item again.  Pressing Command-Z on the keyboard will Undo/Redo as well. Note: This only works with the LAST thing you did, so don't expect it to fix the mistake you made three mistakes ago...
  65.  
  66.     Cut
  67. Will remove the text you have highlighted and place it on the clipboard. Pressing Command-X on the keyboard will Cut as well.
  68.  
  69.     Copy
  70. Will copy the text you have highlighted and place it on the clipboard. Pressing Command-C on the keyboard will Copy as well.
  71.  
  72.     Paste
  73. Pastes a copy of the text from the clipboard into your document, starting at the current location of the insert cursor (flashing vertical line). This does not alter or remove the text on the clipboard, so you can repeatedly paste into many documents. Pressing Command-V on the keyboard will Paste as well.
  74.  
  75.     Clear
  76. Removes the text you have highlighted.  The text is not sent to the clipboard, it is gone.  This command is undoable.
  77.  
  78.     Select All
  79. Highlights the entire document. Pressing Command-A on the keyboard will Select All as well.
  80.  
  81.     Find and Replace╔
  82. This command asks for 'Find' and 'Replace it with' strings, then allows you to find and/or replace the strings in your document. The search through the document begins at the location of insert cursor. Leaving the Replace string blank will allow replacement of something with nothing! Think of it! Pressing Command-F on the keyboard will get you to the Find and Replace dialog as well.
  83.  
  84.         Replace All - Replaces all occurrences of the 'Find' string with
  85.                       'Replace it with' string. See Replace All╔ below for
  86.                       full details.
  87.  
  88.         Replace - Replaces one occurrence of the 'Find' string with 'Replace
  89.                   it with' string. 
  90.  
  91.         Cancel - Cancels the Find operation without further modifying your
  92.                  document.
  93.  
  94.         Find - Will find and highlight the text in the Find string.
  95.  
  96.         Case Sensitive - When this option is checked, the 'Find' string must
  97.                          appear exactly as it is shown before it will be
  98.                          found. 
  99.  
  100.         Match Words - When this option is checked, the 'Find' string must
  101.                       appear as a whole word-with a space before and after
  102.                       it-before it will be found.
  103.  
  104.         Wrap Around - Allows the Find function to continue at the top of the
  105.                       document once it reaches the bottom.  With this option
  106.                       off, the Find will stop at the bottom of the document.
  107.  
  108.     Find Again
  109. Finds the next occurrence on the text from the 'Find' string in the Find dialog. Pressing Command-G on the keyboard will Find Again as well.
  110.  
  111.     Replace Found Selection
  112. Will replace the selected text from the 'Replace it with' string in the Find dialog. Pressing Command-R on the keyboard will Replace Found Selection as well. This makes repeated replaces easy to do by just pressing Command-R over and over.
  113.  
  114.     Replace All╔
  115. Uses the Find and Replace strings and does a 'global' replace throughout the entire document.  The total number of items replaces will be displayed. This action is not undoable.
  116.  
  117.     Preferences
  118. The Preferences dialog allows you to customize the standard operating environment of SaintEdit to your tastes. To restore the default values (including text colors-in case you change them to colors that are unreadable) trash the SaintEdit Preferences file in the System Folder.
  119.  
  120.         Day & Night Colors
  121.     I chose the default colors because they work quite well on color, gray
  122.     scale, and monochrome monitors.  Simply click and hold on each of the six
  123.     color selection boxes, then move the pointer over the new color you want.
  124.     The example text will show you the results of the current selections.
  125.  
  126.         Fastscroll
  127.     Enabling FastScroll (checking the box) will make scrolling much more
  128.     efficient, and therefore faster. What happens is that the thumb (the
  129.     little square in the scroll bar that indicates the relative position of
  130.     the viewable portion of your document) normally is updated and redrawn
  131.     after every line that scrolls up or down. FastScroll only redraws the
  132.     thumb when you are done scrolling (when you release the mouse button).
  133.     The other great feature is that normally if you click and hold below the
  134.     thumb in the scroll bar, the scrolling stops when the thumb reaches your
  135.     pointer.  With FastScroll, you can scroll all the way to the top or bottom
  136.     of a document without "tripping" on the thumb. I can already see all the
  137.     bug reports on this one...
  138.  
  139.         Enable Audible Feedback
  140.     This option is different from having MacinTalk speak text to you. With
  141.     this box checked, certain functions will 'speak' the result to you. Try
  142.     a find for something that isn't in your document (like 'Oyster', for
  143.     example) and listen to what SaintEdit says.
  144.  
  145.         Print Date and Page Number Header
  146.     Checking this box will instruct SaintEdit to add a two-line header to the
  147.     top of each printed page containing the Name of the document, the day,
  148.     date, year and page number.
  149.  
  150.         Wrap Text
  151.     The default window size 80 columns by 80 characters, the standard format
  152.     of text in terminal programs. Choose one of the three text wrap options to
  153.     match the style of document you choose to work with.
  154.  
  155.         Tabs
  156.     The value in the Tabs field is the number of spaces that equal one tab.
  157.     If the value is 4, a tab will be 4 spaces wide.
  158.  
  159.         Default Font
  160.     This is the font that will be used for new documents. The Marciniaco fonts
  161.     are mono-spaced, the Merkle fonts are proportional. The DOS fonts have the    ANSI graphics characters so all the pretty borders and boxes look nice.
  162.  
  163. ______________________________________________________________________________
  164.  
  165. GADGETS MENU
  166.  
  167.     Capitalize First Letter
  168. Like the menu item, this option capitalizes the first letter of each word it encounters. This option only works with text you have selected (highlighted).
  169.  
  170.     Convert to UPPERCASE
  171. This command will capitalize all letters selected. Pressing command-U will also perform this function.
  172.  
  173.     Convert to lowercase
  174. This command will turn all selected text to lowercase. Pressing command-L will also perform this function.
  175.  
  176.     Insert Date
  177. Inserts the current date (at the insertion point) in the form (Thursday, July 28, 1994)
  178.  
  179.     Insert Time
  180. Inserts the current time (at the insertion point) in the form (12:16:26 AM)
  181.  
  182. ______________________________________________________________________________
  183.  
  184. BEDTIME STORIES MENU
  185. When you get tired of reading, let SaintEdit read for you! All you need is either MacinTalk II or MacinTalk Pro in your Extensions folder, a couple of voice files right in there with 'em, and the volume turned up!
  186.  
  187.     Speak All
  188. Will speak the entire document.
  189.  
  190.     Speak Highlighted Text
  191. Highlight the text you want read, and it will do it!
  192.  
  193.     Shut Your A-Trap
  194. Stops any speech in progress. Switching between documents also stops the speech.
  195.  
  196.     Available Voices
  197. This hierarchal menu let's you pick from the available voice definition files in your Extensions folder.
  198.  
  199. ______________________________________________________________________________
  200.  
  201. WINDOWS MENU
  202.  
  203.     Close All
  204. Closes all open documents. If you have created a new document or edited an existing document, you will be asked if you wish to save your work.
  205.  
  206.     (Document Name 1)
  207.             .
  208.             .
  209.             .
  210.     (Document Name 10)
  211. A rhombus will appear in front of the current document. You may have up to 10 documents open at one time.
  212.  
  213. ______________________________________________________________________________
  214.  
  215. WINDOW TOOL BAR
  216.  
  217. At the bottom of each window is a tool bar containing special functions for editing and viewing your document.  When you are over these tools, a 'hand with pointed finger' pointer will appear.
  218.  
  219.     Magnifying Glass Button
  220. This button is identical to choosing Find and Replace from the Edit Menu.
  221.  
  222.     Shamrock Button
  223. The shamrock button toggles show/hide for invisible characters. The characters you will see are: '» for Carriage Return (CR), '┬' for Tab and 'α' for End Of File (EOF). Since SaintEdit is fixed to a monospaced font, I did not use dots to denote spaces: it's hard to distinguish a dot from a period, and spaces are obvious. 
  224.  
  225.     Sun/Moon Button
  226. This button toggles between the text/document colors from the Day/Night settings in the preferences.  This helps when your nice bright work environment turns into a dark dungeon of hate and despair...and it has better contrast in the night setting.
  227.  
  228.     Top Of Document Button
  229. Clicking this button will scroll to the top of the document without changing the location of the insert cursor. Pressing the 'home' key on an extended keyboard yields the same result.
  230.  
  231.     Page Up
  232. Clicking this button will scroll up one page without changing the location of the insert cursor, the same as clicking above the thumb in the scroll bar. Pressing the 'page up' key on an extended keyboard yields the same result.
  233.  
  234.     Page Down
  235. Clicking this button will scroll up down page without changing the location of the insert cursor, the same as clicking below the thumb in the scroll bar. Pressing the 'page down' key on an extended keyboard yields the same result.
  236.  
  237.     Bottom Of Document
  238. Clicking this button will scroll to the bottom of the document without changing the location of the insert cursor. Pressing the 'end' key on an extended keyboard yields the same result.
  239.  
  240.     Help
  241. Clicking the Question Mark button displays a scrollable dialog of the basic SaintEdit commands.  Click inside the help text area to close this dialog and return to editing. Holding down the Option key and clicking the Question Mark displays how many characters are in the current document. Pressing the 'help' key on an extended keyboard also shows the Help dialog.
  242.  
  243.     Fonts Pop-up
  244. SaintEdit uses a customized version of the Monaco and Geneva 9 and 12 point fonts with the following changes:
  245.  
  246. 1. I added a slash to the zero '0' to differentiate it from capital 'O'
  247. 2. I modified capital 'I' to differentiate it from lower case 'l' (as in lime)
  248. 3. The invisible characters used by the Shamrock button will not print.
  249.  
  250. SaintEdit also has DOS font which contain the ANSI graphics characters so you can view a...
  251.  
  252. ______________________________________________________________________________
  253.  
  254. UNIX AND DOS FILES
  255.  
  256. SaintEdit auto converts all known text files.
  257.  
  258. ______________________________________________________________________________
  259.  
  260. MEMORY BASED EDITING
  261.  
  262. I wanted speed, since RAM is abundant and cheap, there are no scratch files or spooling techniques, SaintEdit will be distributed with the RAM partition set to 1MB, this works rather well with a 512K text file load. Although the undo support is memory dynamic, there are scenarios that can use up a lot of memory. As an extremely loose and general rule (subject to change) use the following formula -> (The sum of average working files) x 2. For example: I want to edit between four 128K text files -> [(4 x 128) x 2] = 1024, and so on.
  263.  
  264. ______________________________________________________________________________
  265.  
  266. KNOWN BUGS AND ANOMALIES
  267.  
  268. SaintEdit uses System 7 specific file routines that are not implemented on some Novell servers. If you try to save directly to this volume the save will gracefully fail and warn you - simply save your document to a local Macintosh volume and copy it to the server later. Hey, it's Novell's fault.
  269.  
  270. Documents with lots of Tabs scroll more slowly when showing invisible characters.
  271.  
  272. You can not have blocks of text larger than 32K without at least one carriage return.
  273.  
  274. The special characters in the custom SaintEdit font will not print - In order to ensure print quality, SaintEdit uses the Monaco True type font for output.
  275.  
  276. ______________________________________________________________________________
  277.  
  278. DISCLAIMER
  279.  
  280. The author takes absolutely NO responsibility for this software expressed or implied. There is NO warranty!
  281.  
  282. ______________________________________________________________________________
  283.  
  284. SPECIAL THANKS
  285.  
  286. I would like to thank my ºeta testers (see about box) who were outstanding. You should thank them as well if you run into them...
  287.  
  288. ______________________________________________________________________________
  289.  
  290. Look for all the other neat stuff that I've done on America Online. Thank you for taking the time to read this and for your support...
  291.  
  292. Craig Marciniak
  293. 2019 White Oak
  294. Wichita, KS 67209
  295.  
  296. TemplarDev@aol.com